5.3 编辑外部组织架构(有管理接口用户目录)
请求参数
Path:/api/v1/externalUserGroup/update
Method: POST
接口描述:
注意:该接口文档只针对有管理接口的用户目录的下属组织架构,即用户目录数据来源为外部的用户目录的下属组织架构。
- 对于更新接口中的非必须参数,如果不传,不会对该条数据相对应参数进行修改
- id、name、userDirectoryId为非编辑字段,用于找到对应的数据
- 部分参数,如关联对象ID,需要通过在控制台手动获取,以Chrome浏览器为例,获取方式为F12打开“开发者工具”,在Network中找到对应对象的查询接口手动获取该对象的ID
- 用户目录ID,userDirectoryId获取方式,用“开发者工具”过滤请求 userDirectory/queryAll,打开控制台“业务管理”->“用户管理”页面,查看响应体数据获取对应用户目录的ID,也可以通过用户目录查询接口获取
- 认证策略ID,authComposeId获取方式,用“开发者工具”过滤请求 authCompose/queryAll,在控制台“业务管理”->“认证管理”->“认证策略”页面中打开您新增用户所属的用户目录,找到所属用户目录的认证策略查询接口,查看响应体数据获取对应的认证策略ID
- 用户策略ID,userPolicyId获取方式,用“开发者工具”过滤请求 userPolicy/queryUserPolicy,进入控制台“业务管理”->“策略管理”->“用户策略”页面,查看响应体数据获取所需策略的ID
- 群组ID获取方式,可通过外部用户群组查询接口获取
- 外部组织架构编辑接口不支持编辑关联群组
- 不可编辑名称和所属组织架构
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 必须 |
Body
根据组织架构名称、所属用户目录、所属组织架构编辑
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 必须 | 组织架构名称 | ||
path | string | 必须 | 所属组织架构 | ||
userDirectoryId | string | 与userDirectoryName二选一 | 所属用户目录ID,ID和名称只需传一个即可,都传时以ID为准 | ||
userDirectoryName | string | 与userDirectoryId二选一 | 所属用户目录名称,ID和名称只需传一个即可,都传时以ID为准 | ||
userPolicyId | string | 非必须 | 用户策略ID,ID与名称只需要传一个即可,都传时以ID为准 | ||
userPolicyName | string | 非必须 | 用户策略名称,ID与名称只需要传一个即可,都传时以ID为准 | ||
authComposeId | string | 非必须 | 认证策略ID,ID与名称只需要传一个即可,都传时以ID为准 | ||
authComposeName | string | 非必须 | 认证策略名称,ID与名称只需要传一个即可,都传时以ID为准 | ||
description | string | 非必须 | 描述 | ||
resourceGroupIdEditWay | string | 非必须 | 'set' | 应用分类编辑方式,'set'重置,'append'追加,'delete'删除 | |
resourceGroupIdList | string[] | 非必须 | 应用分类ID列表 | ID列表和名称列表传一个即可,如果都传,以ID列表为准 | |
resourceGroupNameList | string[] | 非必须 | 应用分类名列表 | ID列表和名称列表传一个即可,如果都传,以ID列表为准 | |
resourceIdEditWay | string | 非必须 | 'set' | 应用编辑方式,'set'重置,'append'追加,'delete'删除 | |
resourceIdList | string[] | 非必须 | 应用ID列表 | ID列表和名称列表传一个即可,如果都传,以ID列表为准 | |
resourceNameList | string[] | 非必须 | 应用名列表 | ID列表和名称列表传一个即可,如果都传,以ID列表为准 |
根据组织架构ID编辑
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | string | 必须 | 组织架构ID | ||
userPolicyId | string | 与userDirectoryName二选一 | 用户策略ID,ID与名称只需要传一个即可,都传时以ID为准 | ||
userPolicyName | string | 与userDirectoryId二选一 | 用户策略名称,ID与名称只需要传一个即可,都传时以ID为准 | ||
authComposeId | string | 非必须 | 认证策略ID,ID与名称只需要传一个即可,都传时以ID为准 | ||
authComposeName | string | 非必须 | 认证策略名称,ID与名称只需要传一个即可,都传时以ID为准 | ||
description | string | 非必须 | 描述 | ||
resourceGroupIdEditWay | string | 非必须 | 'set' | 应用分类编辑方式,'set'重置,'append'追加,'delete'删除 | |
resourceGroupIdList | string[] | 非必须 | 应用分类ID列表 | ID列表和名称列表传一个即可,如果都传,以ID列表为准 | |
resourceGroupNameList | string[] | 非必须 | 应用分类名列表 | ID列表和名称列表传一个即可,如果都传,以ID列表为准 | |
resourceIdEditWay | string | 非必须 | 'set' | 应用编辑方式,'set'重置,'append'追加,'delete'删除 | |
resourceIdList | string[] | 非必须 | 应用ID列表 | ID列表和名称列表传一个即可,如果都传,以ID列表为准 | |
resourceNameList | string[] | 非必须 | 应用名列表 | ID列表和名称列表传一个即可,如果都传,以ID列表为准 |
请求示例
{
"id":"e1ded190-5964-11eb-a9a0-931833117fac",
"description": "描述信息",
}
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 错误码,非0表示错误,具体含义请参考错误码定义 | ||
data | object | 必须 | 返回内容 | ||
msg | string | 必须 | 描述信息 |
返回示例
{
"code": 0,
"data": {},
"msg": "请求成功"
}
错误信息
错误提示 | 错误码 |
---|---|
请输入正确的所属组织架构格式:请以“/”开头,组织架构路径不能有连续“/”,且不能以“/”结尾 | 7201 |
应用编辑方式错误,只允许set重置,append追加,delete删除 | 7201 |
应用分类编辑方式错误,只允许set重置,append追加,delete删除 | 7201 |
群组编辑方式错误,只允许set重置,append追加,delete删除 | 7201 |
操作失败,对象不存在或已被其他管理员删除 | 77200004 |
用户目录不存在 | 77200001 |
参数检查出错 | 10000001 |
组织架构名称错误,不能存在/ | 77200005 |
保存失败,关联的应用不存在或已被删除 | 77200004 |
保存失败,关联的应用分类不存在或已被删除 | 77200004 |
名称不能为空 | 10000001 |
用户组织架构不存在 | 10000000 |
认证策略不存在 | 77200004 |
用户最多关联1000个应用 | 77200007 |
用户组织架构名(%s)已存在 | 77200005 |
操作失败 | 10000000 |